Text notes can "include" another note as a read-only widget or an interactive widget, depending on the type of note.

This can be useful for e.g. including a dynamically generated chart (from scripts & "render HTML" note) or other more advanced use cases.

Including a note

In the Formatting toolbar, look for the  button. There is also a keyboard shortcut defined for it but it is not allocated by default.

To include a note that is already linked, right-click a reference link to it in a text note being edited and select Convert link to an included note, at the end of the menu. The include gets the box size that suits the note, as one added from the button does.

An attachment can be included the same way, from the context menu of a link to it (see Embedding an attachment there).

A link to blocks of a text note is converted the same way, with Convert link to note excerpt, and the include then shows only those blocks. See Block references.

Box sizes

The box size sets how much of the included note is shown.

A new include gets the size that suits what it shows:

The dialog that includes a note selects that size once the note is picked, and you can choose another one there. To change the size later, select the include and use the Box size menu in its toolbar, or the Size submenu of its More actions menu.

Resizing

A Small, Medium or Expandable include can be resized to any width and height. A Tiny or Full include always fits its content.

Caption

An include can have a caption, shown centered at the bottom of its box. The caption is part of the text note, so it can be formatted like the rest of the text, for example in bold or with a link.

Title

The title row of an include links to the included note and holds its buttons. To show only the content, select the include and press the Show title button in its toolbar. Pressing it again shows the title.

Opening an included note

To open an included note in a new tab, press the Open in new tab button at the end of its title. An embedded attachment has the same button.

The More actions button at the end of the title row opens the same menu as right-clicking anywhere on the title row: the other places to open the note in and, for an embedded attachment, the actions on the attachment.

In a note being edited, the menu also has the commands of the include's toolbar: the Size submenu, Show title and Show caption, each checked while it is in effect, and Convert to link at the end. A drawing canvas, an included text or code note and an embedded code file also have Editable, above Size. For an embedded attachment they follow its first group of actions; for an included note they end the menu.

To show an include of size Medium or Full on the whole screen, press the Fullscreen button at the end of its title. An excerpt of the blocks of a note has an Edit excerpt button there instead; see Block references. To return, press Exit fullscreen in the top-right corner, or Esc.

A Tiny include has these buttons instead, followed by the same More actions button:

Converting an include to a link

To replace an include with a link to the included note, select it and press the Convert to link button in its toolbar, or choose Convert to link at the end of its More actions menu. An embedded attachment turns into a link to the attachment the same way.

Included notes in the share functionality

If a shared note contains one or more included notes, they will be displayed in the content of the note as if they were part of the note itself. The caption of an include is shown under the included content. A Tiny include is shown as a link to the included note instead, and so is an include that would show a note already shown around it, such as a note that includes itself. The same goes for a printed or exported note.

For this to work, the included notes must also be shared, otherwise they will not be shown. However, the included notes can still be hidden from the note tree via #shareHiddenFromTree.

Interactive notes

Since v0.104.0, included notes might become interactive depending on their note type:

Included images

An included image, whether an image note or an image attachment, is shown in the image viewer, which zooms and pans it:

In a Small or Medium box, the image is scaled down to fit the height of the box. In fullscreen, it fits the screen.

Editing an include in place

An included text note, an included code note and an embedded code file such as a .js, .py or .txt attachment can be edited without leaving the note that includes them. A code note or file is shown with syntax highlighting until then.

Drawing canvases

A drawing canvas is an Excalidraw canvas, like the one of a Canvas note, drawn directly in the text note. It is not a note of its own: the drawing is kept in a Canvas.excalidraw attachment of the text note and is saved together with the text.

Limitations